Vcenter TrustedInfrastructure TrustAuthorityHosts Kms Summary

This schema is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityHosts Kms Summary schema contains all the stored information about a Key Provider Service.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "summary_type": "string",
    "host": "string",
    "address": {
        "hostname": "string",
        "port": 0
    },
    "group": "string",
    "cluster": "string",
    "trusted_ca": {
        "cert_chain": [
            "string"
        ]
    }
}

string

summary_type

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Defines the verbosity of the summary.

For more information see: Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.

This property was added in vSphere API 7.0.0.0.

string

host

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The trusted ESX on which the service runs.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of summary_type is one of Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.BRIEF, Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.NORMAL, or Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.FULL.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.

address

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The service's address.

This property was added in vSphere API 7.0.0.0.

string

group

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The group ID determines which Attestation Service instances this Key Provider Service can communicate with.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of summary_type is one of Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.NORMAL or Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.FULL.

string

cluster

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The opaque string identifier of the cluster in which the Key Provider Service is part of.

This property was added in vSphere API 7.0.0.0.

trusted_ca

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The service's TLS certificate chain.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of summary_type is Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.FULL.

Deprecated